/*
 * Copyright 2020 The Matrix.org Foundation C.I.C.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.matrix.android.sdk.api.session.user.model

/**
 * Data class which holds information about a user.
 * It can be retrieved with [org.matrix.android.sdk.api.session.user.UserService]
 */
data class User(
        val userId: String,
        /**
         * For usage in UI, consider using [getBestName]
         */
        val displayName: String? = null,
        val avatarUrl: String? = null
) {
    /**
     * Return the display name or the user id
     */
    fun getBestName() = displayName?.takeIf { it.isNotEmpty() } ?: userId
}
